Vcenter Cluster FilterSpec

The Vcenter Cluster FilterSpec schema contains properties used to filter the results when listing clusters (see GET /vcenter/cluster). If multiple properties are specified, only clusters matching all of the properties match the filter.

JSON Example

{
    "clusters": [
        "string"
    ],
    "names": [
        "string"
    ],
    "folders": [
        "string"
    ],
    "datacenters": [
        "string"
    ]
}

array of string

clusters

Optional

Identifiers of clusters that can match the filter.

If missing or null or empty, clusters with any identifier match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ClusterComputeResource.

array of string

names

Optional

Names that clusters must have to match the filter (see Vcenter Cluster Info.name).

If missing or null or empty, clusters with any name match the filter.

array of string

folders

Optional

Folders that must contain the cluster for the cluster to match the filter.

If missing or null or empty, clusters in any folder match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Folder. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Folder.

array of string

datacenters

Optional

Datacenters that must contain the cluster for the cluster to match the filter.

If missing or null or empty, clusters in any datacenter match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Datacenter. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Datacenter.